home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / bin / parsechangelog < prev    next >
Text File  |  2009-02-17  |  9KB  |  273 lines
  1. #!/usr/bin/perl 
  2.  
  3. eval 'exec /usr/bin/perl  -S $0 ${1+"$@"}'
  4.     if 0; # not running under some shell
  5. # -*- perl -*-
  6. # Copyright 2005 Frank Lichtenheld <frank@lichtenheld.de>
  7. #
  8. #    This program is free software; you can redistribute it and/or modify
  9. #    it under the terms of the GNU General Public License as published by
  10. #    the Free Software Foundation; either version 2 of the License, or
  11. #    (at your option) any later version.
  12. #
  13. #    This program is distributed in the hope that it will be useful,
  14. #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16. #    GNU General Public License for more details.
  17. #
  18. #    You should have received a copy of the GNU General Public License
  19. #    along with this program; if not, write to the Free Software
  20. #    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  21. #
  22.  
  23. =head1 NAME
  24.  
  25. parsechangelog - parse Debian changelogs and output them in other formats
  26.  
  27. =head1 SYNOPSIS
  28.  
  29. parsechangelog [options] [changelogfile]
  30.  
  31.  Options:
  32.     --help, -h                  print usage information
  33.     --version, -V               print version information
  34.     --file, -l <file>           changelog file to parse, defaults
  35.                                 to 'debian/changelog'
  36.     -F<changelogformat>         ignored if changelogformat = 'debian'
  37.                                 for compatibility with dpkg-dev
  38.     -L<libdir>                  ignored for compatibility with dpkg-dev
  39.     --format <outputformat>     see man page for list of available
  40.                                 output formats, defaults to 'dpkg'
  41.                                 for compatibility with dpkg-dev
  42.     --since, -s, -v <version>   include all changes later than version
  43.     --until, -u <version>       include all changes earlier than version
  44.     --from, -f <version>        include all changes equal or later
  45.                                 than version
  46.     --to, -t <version>          include all changes up to or equal
  47.                                 than version
  48.     --count, -c, -n <number>    include <number> entries from the top
  49.                                 (or the tail if <number> is lower than 0)
  50.     --offset, -o <number>       change the starting point for --count,
  51.                                 counted from the top (or the tail if
  52.                                 <number> is lower than 0)
  53.     --all                       include all changes
  54.  
  55. If neither C<changelogfile> nor C<-l E<lt>fileE<gt>> are specified,
  56. F<debian/changelog> will be used. If two different files are
  57. specified the program will abort.
  58.  
  59. If the filename is C<-> the program reads the changelog from
  60. standard input.
  61.  
  62. C<--all> overrides all other range selecting options. C<--count>
  63. overrides all other range selection options except for C<--all>.
  64. The range selecting options can be mixed together, but only one
  65. of C<--since> and C<--from> and one of C<--until> and C<--to> can be
  66. specified at the same time.
  67.  
  68. The dpkg and rfc822 formats default to showing only the first entry
  69. when no other options are given with while the HTML and XML formats
  70. default to showing all entries.
  71.  
  72. For a more extensive documentation of the range selecting options and
  73. some (hopefully enlightening) examples see
  74. L<Parse::DebianChangelog/"COMMON OUTPUT OPTIONS">.
  75.  
  76. =head1 DESCRIPTION
  77.  
  78. parsechangelog parses Debian changelogs as described in the Debian
  79. policy (version 3.6.2.1 at the time of this writing) and converts
  80. them to other output formats. See section L<"SEE ALSO"> for
  81. locations where to find the full format definition.
  82.  
  83. The output formats supported are currently:
  84.  
  85. =over 4
  86.  
  87. =item dpkg
  88.  
  89. Format as known from L<dpkg-parsechangelog(1)>. All requested entries
  90. (see L<"SYNOPSIS"> on how to select specific entries) are returned in
  91. the usual Debian control format, merged in one stanza, ready to be used
  92. in a F<.changes> file.
  93.  
  94. =item rfc822
  95.  
  96. Similar to the C<dpkg> format, but the requested entries are returned
  97. as one stanza each, i.e. they are not merged. This is probably the format
  98. to use if you want a machine-usable representation of the changelog.
  99.  
  100. =item xml
  101.  
  102. Just a simple XML dump of the changelog data. Without any schema or
  103. DTD currently, just some made up XML. The actual format might still
  104. change. Comments and Improvements welcome.
  105.  
  106. =item html
  107.  
  108. The changelog is converted to a somewhat nice looking HTML file with
  109. some nice features as a quick-link bar with direct links to every entry.
  110. NOTE: This is not configurable yet and was specifically designed
  111. to be used on L<http://packages.debian.org/>. This is planned to be
  112. changed until version 1.0. The used Parse::DebianChangelog module
  113. already supports configuration, however, this isn't exposed by this
  114. program yet.
  115.  
  116. =back
  117.  
  118. =cut
  119.  
  120.     use strict;
  121. use warnings;
  122.  
  123. use Getopt::Long qw(:config gnu_getopt auto_help);
  124. use Pod::UsageTrans;
  125. use Locale::gettext;
  126. use POSIX;
  127. use Parse::DebianChangelog;
  128.  
  129. setlocale(LC_MESSAGES, '');
  130. textdomain('Parse-DebianChangelog');
  131.  
  132. my ( $since, $until, $from, $to, $all, $count, $offset, $file );
  133. my $default_file = 'debian/changelog';
  134. my $format = 'dpkg';
  135. my %allowed_formats = (
  136.                dpkg => 1,
  137.                html => 1,
  138.                xml => 1,
  139.                rfc822 => 1,
  140.                );
  141.  
  142. sub unsupported {
  143.     my ($opt, $val) = @_;
  144.  
  145.     $opt ||= '';
  146.     $val ||= '';
  147.  
  148.     if ($opt eq 'F' and $val ne 'debian') {
  149.     die sprintf( gettext('changelog format %s not supported')."\n",
  150.              $val );
  151.     }
  152.  
  153.     if ($opt eq 'L') {
  154.     warn gettext('ignored option -L')."\n";
  155.     }
  156. }
  157.  
  158. sub set_format {
  159.     my ($opt, $val) = @_;
  160.  
  161.     unless ($allowed_formats{$val}) {
  162.     die sprintf( gettext('output format %s not supported')."\n",
  163.              $val );
  164.     }
  165.  
  166.     $format = $val;
  167. }
  168.  
  169. sub help {
  170.     pod2usage(-msg => "$0 $Parse::DebianChangelog::VERSION\n".
  171.           gettext( "Copyright (C) 2005 by Frank Lichtenheld\n" ).
  172.           gettext( "This is free software; see the GNU General Public ".
  173.                "Licence version 2 or later for copying conditions. ".
  174.                "There is NO warranty." )."\n",
  175.           -textdomain => 'Parse-DebianChangelog-Pod',
  176.           -exitstatus => 0);
  177. }
  178.  
  179. sub version {
  180.     print "$0 $Parse::DebianChangelog::VERSION\n";
  181.     exit 0;
  182. }
  183.  
  184. GetOptions( "file|l=s" => \$file,
  185.         "since|v=s" => \$since,
  186.         "until|u=s" => \$until,
  187.         "from|f=s" => \$from,
  188.         "to|t=s" => \$to,
  189.         "count|c|n=i" => \$count,
  190.         "offset|o=i" => \$offset,
  191.         "F=s" => \&unsupported,
  192.         "L=s" => \&unsupported,
  193.         "help|h" => \&help,
  194.         "version|V" => \&version,
  195.         "format=s" => \&set_format,
  196.         "all|a" => \$all,
  197.         )
  198.     or pod2usage({
  199.     -exitvalue => 2,
  200.     -textdomain => 'Parse-DebianChangelog-Pod'
  201.         });
  202.  
  203. die gettext('too many arguments')."\n" if @ARGV > 1;
  204.  
  205. if (@ARGV) {
  206.     if ($file && ($file ne $ARGV[0])) {
  207.     die sprintf( gettext('more than one file specified (%s and %s)')."\n",
  208.              $file, $ARGV[0] );
  209.     }
  210.     $file = $ARGV[0];
  211. }
  212.  
  213. my $changes = Parse::DebianChangelog->init();
  214.  
  215. $file ||= $default_file;
  216. if ($file eq '-') {
  217.     my @input = <STDIN>;
  218.     $changes->parse({ instring => join('', @input) })
  219.     or die sprintf( gettext('fatal error occured while parsing %s')."\n",
  220.             'input' );
  221. } else {
  222.     $changes->parse({ infile => $file })
  223.     or die sprintf( gettext('fatal error occured while parsing %s')."\n",
  224.             $file );
  225. }
  226.  
  227.  
  228. my @all = $all ? ( all => $all ) : ();
  229.  
  230. {
  231.     # I know that looks ugly, but at least it is safer than an eval...
  232.     no strict 'refs';
  233.     my $func_name = "Parse::DebianChangelog::${format}_str";
  234.     print &{"$func_name"}( $changes,
  235.                { since => $since, until => $until,
  236.                  from => $from, to => $to,
  237.                  count => $count, offset => $offset,
  238.                  @all });
  239. }
  240.  
  241. __END__
  242.  
  243. =head1 SEE ALSO
  244.  
  245. Parse::DebianChangelog, the underlying Perl module
  246.  
  247. Description of the Debian changelog format in the Debian policy:
  248. L<http://www.debian.org/doc/debian-policy/ch-source.html#s-dpkgchangelog>.
  249.  
  250. =head1 AUTHOR
  251.  
  252. Frank Lichtenheld, E<lt>frank@lichtenheld.deE<gt>
  253.  
  254. =head1 COPYRIGHT AND LICENSE
  255.  
  256. Copyright (C) 2005 by Frank Lichtenheld
  257.  
  258. This program is free software; you can redistribute it and/or modify
  259. it under the terms of the GNU General Public License as published by
  260. the Free Software Foundation; either version 2 of the License, or
  261. (at your option) any later version.
  262.  
  263. This program is distributed in the hope that it will be useful,
  264. but WITHOUT ANY WARRANTY; without even the implied warranty of
  265. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  266. GNU General Public License for more details.
  267.  
  268. You should have received a copy of the GNU General Public License
  269. along with this program; if not, write to the Free Software
  270. Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  271.  
  272. =cut
  273.